home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / tyahtz49.zip / YAHTZEE.DOC < prev    next >
Text File  |  1992-06-18  |  22KB  |  492 lines
  1.  
  2.                             TRIPLE   YAHTZEE
  3.  
  4.                                   v4.9
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                             (404) 256-9525
  12.  
  13.  
  14.  
  15.  
  16.                                 OVERVIEW
  17.                                 ________
  18.  
  19.  
  20.    Triple Yahtzee is played exactly like the board game. A high score file
  21.    is maintained  (size is controlled from the configuration file). Since
  22.    this game can take a while to play to completion,  a game save feature
  23.    has been included. This feature allows the caller to save the  game
  24.    contents and return to the same game on their next call automatically.
  25.  
  26.  
  27.  
  28.    NOTE: Most errors will be logged to a file called DFRAME.ERR, which is
  29.          created in the directory you run the door from.
  30.  
  31.  
  32.  
  33.                               INSTALLATION
  34.                               ____________
  35.  
  36.  
  37.    Installation is fairly easy and straight-forward. The following steps and
  38.    examples should have you up and running in a very short period of time.
  39.    It is assumed that you are familiar with setting up DOORS on your system.
  40.    To this end, only examples of the configuration file and Door batch file
  41.    are described.
  42.  
  43.       1) Create a directory to hold all YAHTZEE files
  44.  
  45.       2) Unzip TYAHTZxx.ZIP into the the above directory
  46.  
  47.          NOTE: BRUN45.EXE is not included but is required !!!
  48.  
  49.       3) Create a configuration file, with a name of your choice, or
  50.          modify the supplied YAHTZEE.CFG file. A description follows:
  51.  
  52.             **                       Location of System file
  53.  
  54.             SUNRISE-80 BBS           Your BBS Name
  55.  
  56.             Al                       SYSOP's First Name
  57.  
  58.             Lawrence                 Sysop's Last Name
  59.  
  60. |-----------------------------------------------------------------------------|
  61. | READ!     1                        CommPort  \ These 2 lines are required   |
  62. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  63. |-----------------------------------------------------------------------------|
  64.  
  65.             00000000                 Registration Number
  66.  
  67.             50                       Number of Top Score entries.
  68.                                      Minimum = 10, Maximum = 99.
  69.  
  70.         #   2                        Keyboard timeout value in minutes.
  71.                                      If key not depressed for 2 minutes
  72.                                      board is saved and caller is returned
  73.                                      to BBS. Minimum=2, Maximum=5
  74.  
  75.         #   NONE                     Drive:\Path\Filename to contain the
  76.                                      Top Score Bulletin or enter NONE
  77.                                      for NO Bulletin creation.
  78.  
  79.         #   NONE                     Drive:\Path\Filename to contain the
  80.                                      Top Score Bulletin (Color) or enter NONE
  81.                                      for NO Bulletin creation.
  82.  
  83.             1                        Initial setting of the HOTKEY feature.
  84.                                      1=ON, 0=OFF. Default will be 1 if any
  85.                                      other value is encountered.
  86.  
  87.             2                        1 = DO NOT Display the ADOPT-A-DOOR Msg
  88.                                      2 = DO Display the ADOPT-A-DOOR Message
  89.                                      When YAHTZEE is Registerd, this option
  90.                                      will have no effect. This option is for
  91.                                      those Sysops that do not like the
  92.                                      ADOPT-A-DOOR Concept.
  93.  
  94.             
  95.         #   1                        Color of Main Portion of Board
  96.                                      1=Blue, 4=Red, 5=Magenta, 14=Yellow
  97.  
  98.             2                        1=Caller will appear only one time in the
  99.                                        HiScore file
  100.                                      2=Caller can appear any number of times in
  101.                                        then Hiscore file
  102.  
  103.  
  104.     !   #   1                        Number of games allowed each day
  105.                                      (Sysop gets 99 in registered version ONLY!)
  106.  
  107.     !   #   1                        Time Allowed in Door
  108.                                      (Sysop = Time Remaining - REG. VERSION)
  109.  
  110.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  111.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  112.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  113.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  114.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  115.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  116.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  117.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  118.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  119.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  120.  
  121.     @   #   XXXX/YYYY                 Blackout Range  From/To
  122.     @   #   XXXX/YYYY                 Blackout Range  From/To
  123.     @   #   XXXX/YYYY                 Blackout Range  From/To
  124.     @   #   XXXX/YYYY                 Blackout Range  From/To
  125.     @   #   XXXX/YYYY                 Blackout Range  From/To
  126.  
  127.  
  128.        ** = Replace with ONE of the following:
  129.  
  130. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  131. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  132. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  133.                                    (Note:DOOR.SYS must be in SAME directory)
  134. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  135. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  136. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  137. C:\BBS\CHAIN.TXT                <- For WWIV systems 
  138. C:\BBS\GTUSER.BBS               <- For GT Power 
  139.                                    * if using this option you must put the
  140.                                      ComPort # on line 5 and the Node # on
  141.                                      line 6 of the configuration file
  142.  
  143.  
  144.  
  145.         # = Requires registration to change to a different value
  146.         ! = See "Plays Per DAY/DOOR Time" Below
  147.         @ = See "Blackout Periods" Below
  148.  
  149.  
  150.       4) Create a batch file or modify the YAHTZEE file supplied. A
  151.          description of this file follows:
  152.  
  153.             ECHO off
  154.             cd\PCB\DOORS\YAHTZEE      Location of Yahtzee files
  155.             YAHTZEE YAHTZEE.CFG       EXE filename and CFG filename (Name
  156.                                       used in creating file in #3 above)
  157.             CD\PCB
  158.             BOARD
  159.  
  160.  
  161.        5) When running in more than one node, be sure to supply a
  162.           different configuration name for each node (your choice of name).
  163.  
  164.  
  165.  
  166.                           BLACKOUT PERIODS
  167.                           ________________
  168.  
  169.       Use the Blackout ranges option to define up to 5 time periods during
  170.       which you DO NOT want the Door to be played. If a caller tries to access 
  171.       the Door during the Blackout period, they will be shown a message that
  172.       contains ALL the Blackout periods you have defined, and to try the Door
  173.       at a later time.
  174.  
  175.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  176.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  177.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  178.  
  179.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  180.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  181.                    a Blackout range.
  182.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  183.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  184.             NOTE: There should be NO BLANK LINES in the configuration file!
  185.  
  186.  
  187.  
  188.                           PLAYS Per DAY/DOOR Time
  189.                           _______________________
  190.  
  191.       Plays Per Day and Door Time can be controlled several ways:
  192.  
  193.       (1) You can use the Games Per Day, singular option, in the config
  194.           file above. This option, will affect ALL callers whose Security
  195.           Level is NOT defined in any of the 10 optional Security Level/
  196.           Plays Per Day entries in the config file.
  197.  
  198.       (2) You can use the Door Time, singular option, in the config file
  199.           above. This option, will affect ALL callers whose Security
  200.           Level is NOT defined in any of the 10 optional Security Level/
  201.           Plays Per Day/Door Time entries in the config file.
  202.  
  203.       (3) You can restrict the number of games a specific Security Level
  204.           will be allowed to play per day or REWARD specific Levels with 
  205.           more Plays Per Day. 
  206.  
  207.           Likewise, you can restrict the Play time for a specific Security
  208.           Level or REWARD specific Levels with more Door Time.
  209.  
  210.           These options are handled by the use of the 10 config 
  211.           entries (000=00/00). 
  212.           
  213.           The format of each entry is as follows:
  214.  
  215.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  216.                      where =  is a constant and MUST be included
  217.                      where YY is the # of games per day (must be 2 digits)
  218.                      where / is a constant and MUST be included
  219.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  220.           
  221.           If the callers Security Level is NOT defined, his/her Plays Per
  222.           Day and Door Time will be controlled by the values in items
  223.           (1) and (2), above, respectively..
  224.  
  225.           You may define up to 10 Security Levels. All unused entries must
  226.           be defined as   000=00/00
  227.         --------------------------------------------------------------------
  228.           Example: Suppose you had 3 Security Levels defined on your BBS as
  229.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you 
  230.           wanted to set Plays Per Day as :     Subscriber=5
  231.                                            Visiting Sysop=2
  232.                                                   CoSysop=3
  233.                                                    Friend=10 
  234.           
  235.           and Door Time as follows:     Subscriber=30 minutes
  236.                                     Visiting Sysop=20 minutes
  237.                                            CoSysop=10 minutes 
  238.                                             Friend=remaining call time
  239.                                
  240.  
  241.           You would set the Individual "Games per Day" config entry to 1 and 
  242.           the individual "Door Time" to 5 minutes (these would be the 
  243.           default number of games and default Time for all Security Levels
  244.           other than 20,30 or 40... make them any number you want). Next you
  245.           would replace 4 of the Security Level entries as :  020=05/30                                               
  246.                                                               030=02/20
  247.                                                               040=03/10
  248.                                                               090=10/0
  249.  
  250.  
  251.                         NON-STANDARD COM SUPPORT
  252.                         ________________________
  253.  
  254.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  255.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  256.       number after the configuration filename. Let's assume your Door is
  257.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  258.       passed to your Door would be:
  259.  
  260.                             FOOBAR FOOBAR.CFG /5
  261.  
  262.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  263.       normally used with COM1. No /x parameter is needed for the standard
  264.       IRQ's.
  265.  
  266.       As an alternative, you may use an environmental variable on the command
  267.       line. To use the variable (following the example above), place a 
  268.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a 
  269.       different IRQ number for each node). The command line would now look 
  270.       like this: 
  271.  
  272.                           FOOBAR FOOBAR.CFG /%IRQ%
  273.       
  274.       This, in combination with the use of the environmental variables 
  275.       described in the MULTI-NODE SETUP section will allow you to use one 
  276.       batch file and one config file to run this door on all nodes.
  277.  
  278.  
  279.  
  280.  
  281.                            MULTI-NODE SETUP
  282.                            ________________
  283.  
  284.       All Sunrise Doors are Multi-Node capable. Each node must have the 
  285.       ability to access a configuration file which will have its own system 
  286.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first 
  287.       line. There are 2 ways to accomplish this:
  288.  
  289.       (1) Create a separate configuration file for each node. The only 
  290.           difference between each file would be the location of the system 
  291.           file for that particular node. For example, on my system there are 2
  292.           nodes and the first line of the config files would look like this:
  293.  
  294.                         NODE1:  H:\PCB1\DOOR.SYS
  295.                         NODE2:  H:\PCB2\DOOR.SYS
  296.  
  297.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  298.  
  299.       (2) Use ONE configuration file for ALL nodes. This Door will recognize 
  300.           the following PCBoard environmental variables:
  301.  
  302.                  PCBDIR    (Directory containing the System file)
  303.                  PCBDRIVE  (Drive containing the System file)
  304.  
  305.           Thus, the first line of the SINGLE configuration file, for this Door
  306.           would look like this:
  307.  
  308.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  309.  
  310.       NOTE: This option, as described, assumes that you are running PCBoard 
  311.             14.5a software. The environmental variables are automatically 
  312.             created by the software for each node.
  313.  
  314.             HOWEVER, if you are running other BBS software you should be able
  315.             to set the variables EXACTLY as described below, for EACH node 
  316.             (more than likely in each batch file you use to bring up EACH node):
  317.  
  318.                             PCBDRIVE=C:
  319.                             ^^^^^^^^^
  320.                             PCBDIR=\NODE2
  321.                             ^^^^^^^^
  322.             
  323.             Info with a carat (^) under it, MUST be typed as is. The rest 
  324.             depends on your naming conventions. 
  325.  
  326.             This, in combination with the use of the optional environmental
  327.             variable described in the NON-STANDARD COM SUPPORT section, will
  328.             allow you to use one batch file and one config file to run this 
  329.             door on all nodes.
  330.  
  331.  
  332.  
  333.  
  334.                       UPLOADED SCORE UPDATING(PC-YAHTZEE)
  335.                       ___________________________________
  336.     
  337.    
  338.     Triple Yahtzee's companion program, PC-YAHTZEE, is used by your callers 
  339.     to play Triple Yahtzee offline on their PC's. When they register PC-YAHTZEE,
  340.     they unlock the ability to upload their scores to your BBS. You in turn 
  341.     combine all uploaded scores and merge them into your BBS' Triple Yahtzee
  342.     high score file. You have the option to implement this feature or not.
  343.     
  344.     Your callers will be uploading numeric filenames with .UPL as the
  345.     extension (ex: 12345678.UPL). You can have them upload them to a private
  346.     upload directory or to your regular upload directory. If you choose the
  347.     regular upload directory, then be sure you allow uploads with a .UPL 
  348.     extension. The uploaded filename is a fixed format, unique to each user
  349.     of PC-YAHTZEE. Be sure to let your callers know how/where to upload their
  350.     Yahtzee High Score files !
  351.  
  352.     I would appreciate your posting the latest PC-YAHTZEE program as I believe
  353.     it will benefit the throughput of your board, by reducing the amount of 
  354.     time spent playing Triple Yahtzee. Please be sure to download a copy for
  355.     yourself and POST one on your BBS!!!    
  356.     
  357.     Should you decide to implement (and I would suggest that you do), use the
  358.     following batch file (modify where appropriate) to automate this updating
  359.     process.
  360.  
  361.        
  362.            (1) D:
  363.            (2) CD\NEWUPLD
  364.            (3) COPY *.UPL YAHTZEE.CMB
  365.            (4) DEL *.UPL
  366.            (5) COPY YAHTZEE.CMB C:\PCB\DOORS\YAHTZEE3\
  367.            (6) DEL YAHTZEE.CMB
  368.            (7) C:
  369.            (8) CD\C:\PCB\DOORS\YAHTZEE3
  370.            (9) YAHTZMRG YAHTZEE.CFG
  371.           (10) DEL YAHTZEE.CMB
  372.  
  373.      (1) Change to D: drive
  374.      (2) Change to directory containing the uploaded score files
  375.      (3) Merge all .UPL files into YAHTZEE.CMB (DO NOT rename YAHTZEE.CMB !!!)
  376.      (4) Delete uploaded files (*.UPL)
  377.      (5) Copy YAHTZEE.CMB to Triple Yahtzee door directory
  378.      (6) Delete YAHTZEE.CMB from upload directory
  379.      (7) Change to C: drive
  380.      (8) Change to Triple Yahtzee door directory
  381.      (9) Merge uploaded scores with YAHZTEE.SCO file(Use Yahtzee config file)
  382.     (10) Delete YAHTZEE.CMB
  383.  
  384.          NOTE: This can be run in a nightly event process!!
  385.  
  386.     When merging, YAHTZMRG.EXE will reject duplicate entries within the 
  387.     uploaded file(s) as well as entries that duplicate existing entries 
  388.     in the YAHTZEE.SCO file. The uploaded score file(s) are created by 
  389.     PC-YAHTZEE. Any attempt to change these scores with an editor will
  390.     result in YAHTZMRG rejecting them outright.
  391.  
  392.  
  393.  
  394.                                ADOPT-A-DOOR
  395.                                ____________
  396.  
  397.     Having been a Sysop for a number of years, I have had my share of problems
  398.     and frustrations getting financial support for my board's upkeep. A fellow
  399.     Sysop left a message on my board, not long ago, about a concept that was
  400.     being used by several boards around the country.
  401.  
  402.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  403.     would be the same as sending in a donation, only this way it is earmarked
  404.     for registering a particular door. In a way, the user feels he/she is
  405.     "getting something in return". As a Door author I have decided to build
  406.     this concept into each of my Door programs. The concept replaces the
  407.     usual message "tell the Sysop to register this Door" we find in most
  408.     doors.
  409.  
  410.     If the Door is unregisterd then a message appears on the opening screen
  411.     to that effect. After finishing or suspending a game, a message screen
  412.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  413.     caller to contact the Sysop to find out if there is any further details
  414.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  415.     time, etc to callers that ADOPT-A-DOOR.
  416.  
  417.     If the Door has been registered, either by the Sysop or other callers,
  418.     the names of those contributors will be displayed in the closing screen.
  419.  
  420.     NOTE: If you want to display the names of the callers that contributed
  421.           to registering the Door, you must create an ASCII file called
  422.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  423.           the name(s) of the contributors (one on each line, maximum of 5
  424.           entries, each a maximum of 30 characters long). This file must be
  425.           saved, in ASCII format, and placed in the Door directory.
  426.  
  427.  
  428.  
  429.                               LEGALITIES
  430.                               __________
  431.  
  432.  
  433.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  434.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  435.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  436.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  437.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  438.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  439.       OR BREACH OF ANY WARRANTY.
  440.  
  441.  
  442.  
  443.  
  444.  
  445.                              DISTRIBUTION
  446.                              ____________
  447.  
  448.    You may make this file available for downloading from your BBS or you may
  449.    upload it to any BBS of your choice, provided that you do not make any
  450.    changes to the contents of the archive (ZIP file). The archive and its
  451.    individual contents may not be used by any service that charges any money
  452.    whatsoever, without the written permission of the author.
  453.  
  454.  
  455.  
  456.  
  457.  
  458.                              REGISTRATION
  459.                              ____________
  460.  
  461.    Registration and the subsequent insertion of the registration number into
  462.    your configuation file, allows for the display of your BBS name on the
  463.    opening and closing screen as well as the reduction of a delay built into
  464.    the opening screen display along with the ability to change certain values
  465.    in the configuration file.
  466.  
  467.    To register your copy of YAHTZEE, please fill out the registration form
  468.    (REGISTER.FRM) and mail it along with a small donation ( $25) to
  469.    the name and address on the form.
  470.  
  471.    Be sure to use the proper upper/lower case when filling in your name and
  472.    BBS name, as they MUST match the way you entered them in the configuration
  473.    file.             ^^^^
  474.  
  475.    Based upon information supplied on the registration form, I will pre-
  476.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  477.    up your registration number or supply a self-addressed stamped envelope.
  478.  
  479.  
  480.  
  481.                                  MISC
  482.                                  ____
  483.  
  484.    The latest version of TRIPLE YAHTZEE and other fine SUNRISE DOOR programs
  485.    are always available for download from SUNRISE-80 BBS and/or SALTAIR BBS.
  486.  
  487.    Remember, should you have any problems, questions or suggestions, be sure
  488.    to drop me a message on either of the aforementioned BBS' or via the 
  489.    DOORS conference on PCRELAY/RIME, Node=SUNRISE.
  490.  
  491.  
  492.